Métodos de Pagamento

Aqui você encontrará todos os serviços associados à nossa plataforma

Detalhes

Método	Imagem	Método de Pagamento	Soluções
Pix+		belvo_payment	Open-Finance

Pix+ v1

Como Criar um Pagamento

POST - https://url.base/api/payment/new

Endpoint para criar um novo pagamento. Para criar uma nova solicitação de pagamento,
 a solicitação deve ser construída com os seguintes parâmetros.

Campo	Tipo	Descrição
*currency	String	Código de moeda ISO # Países e moedas​​
*country	String	Formato do país internacional. # Países e moedas​​​​​​
*amount	Integer	Valor da transação​​​​​
*clientName	String	Nome completo do cliente​​​​​
*clientEmail	String	E-mail do cliente​​​
*clientPhone	String	Telefone do cliente
*clientDocument	String	Documento do cliente
*paymentMethod	String	Métodos de pagamentos disponíveis. Conheça os métodos disponíveis para o seu negócio
*urlConfirmation	Link	Url de confirmação do pagamento
*urlFinal	Link	Redirecionamento da URL após a conclusão do pagamento
*urlRejected	Link	Redirecionamento da URL em caso de transação rejeitad
*order	String	Identificador do pagamento a associar. O campo "order" deve ser único e não repetível
*sign	String	A assinatura dos parâmetros é única para cada transação
*typePixPayment	Integer	Este campo se refere ao tipo de pagamento que oferecemos ao cliente. Entre eles estão: Valor (1) Pagamento imediato, Valor (2) Pagamento com data de vencimento (temporariamente desativado), Valor (3) Pagamento por lotes com data de vencimento (temporariamente desativado)
*isIframePay	Boolean	Se 'isIframePay' for TRUE, será fornecido um iframe e um código PIX para integração na página do comerciante. Se 'isIframePay' for FALSE, você receberá uma URLPAY, que deverá redirecionar o cliente para o sistema de pagamento da Prontopaga

info

Como recomendação, esta informação deve vir do perfil do cliente.

Exemplo

{
    $data = [
        "currency" => "BRL",
        "country" => "BR",
        "amount" => 1000,
        "clientName" => "Demo",
        "clientEmail" => "[email protected]",
        "clientPhone" => "999999999",
        "clientDocument" => "33177114692",
        "paymentMethod" => "pix_payment",
        "urlConfirmation" => "webhook",
        "urlFinal" => "url rediret",
        "urlreject" => "url reject",
        "order" => "order id"
        "sing" => "Assinatura dos parâmetros"
        "typePixPayment" => 1 (Por padrão),
        "isIframePay" => true (or false),
    ];
}

Resposta Criar um pagamento

A resposta da ProntoPaga ao pedido de pagamento é o UID da transação e o URL para o qual deve redirecionar o usuário.

Exemplo de Pedido Bem-sucedido

{
"urlPay": [string], // Link para processar o pagamento
"uid": [string] // Identificador de pagamento no sistema
}

Pix+ v2

Como Criar um Pagamento

POST - https://url.base/api/payment/v2/new

Endpoint para criar um novo pagamento. Para criar uma nova solicitação de pagamento,
 a solicitação deve ser construída com os seguintes parâmetros.

Campo	Tipo	Descrição
*currency	String	Código de moeda ISO # Países e moedas​​
*country	String	Formato do país internacional. # Países e moedas​​​​​​
*amount	Integer	Valor da transação​​​​​
*clientName	String	Nome completo do cliente​​​​​
*clientEmail	String	E-mail do cliente​​​
*clientPhone	String	Telefone do cliente
*clientDocument	String	Documento do cliente
*paymentMethod	String	Métodos de pagamentos disponíveis. Conheça os métodos disponíveis para o seu negócio
*urlConfirmation	Link	Url de confirmação do pagamento
*urlFinal	Link	Redirecionamento da URL após a conclusão do pagamento
*urlRejected	Link	Redirecionamento da URL em caso de transação rejeitad
*order	String	Identificador do pagamento a associar. O campo "order" deve ser único e não repetível
*sign	String	A assinatura dos parâmetros é única para cada transação

info

Como recomendação, esta informação deve vir do perfil do cliente.

Exemplo

{
    $data = [
        "currency" => "BRL",
        "country" => "BR",
        "amount" => 1000,
        "clientName" => "Demo",
        "clientEmail" => "[email protected]",
        "clientPhone" => "999999999",
        "clientDocument" => "33177114692",
        "paymentMethod" => "pix_payment",
        "urlConfirmation" => "webhook",
        "urlFinal" => "url rediret",
        "urlreject" => "url reject",
        "order" => "order id"
        "sing" => "Assinatura dos parâmetros"
    ];
}

Resposta Criar um pagamento

A resposta da ProntoPaga ao pedido de pagamento é o UID da transação e o URL para o qual deve redirecionar o usuário.

Exemplo de Pedido Bem-sucedido

{
"urlPay": [string], // Link para processar o pagamento
"uid": [string] // Identificador de pagamento no sistema
}

Seleção de instituição de pagamento

Uma vez que o cliente seleciona o banco, eles devem enviar o id da instituição e o uid do pagamento.

POST - https://url.base/api/payment/v2/start

Endpoint para iniciar o pagamento.

Campo	Tipo	Descrição
*id_institution	String	ID da instituição bancária selecionada
*uid	String	UID do pagamento

Resposta

{
  "url_bank_payment"= [string] // URL do pagamento bancário
  "uid"= [String] // Identificador do pagamento no sistema

}